PBDTSetCommentSync

PBDTSetCommentSync
Header:	Files.h		Carbon status:	Supported

Adds a user comment for a file or a directory to the desktop database. This function runs synchronously.

OSErr PBDTSetCommentSync (
    DTPBPtr paramBlock
);

paramBlock: A pointer to a desktop parameter block.

function result: A result code.

DISCUSSION

Clear all fields (other than input fields) in the parameter block that you pass to Desktop Manager functions. The relevant fields of the parameter block for this function are:

ioCompletionOn input, a universal procedure pointer to a completion function. A value of type IOCompletionUPP.
ioResultOn return, the result code of the function. A value of type OSErr.
ioNamePtrOn input, a pointer to a file or directory name. A value of type StringPtr.
ioDTRefNumOn input, the desktop database reference number. A value of type SInt16.
ioDTBufferOn input, a pointer to the buffer containing the comment text. You put the comment in the buffer as a plain text string. A value of type Ptr.
ioDTReqCountOn input, the the length of the buffer (in bytes) containing the comment text. The maximum length of a comment is 200 bytes; longer comments are truncated. Since the comment is a plain text string and not a Pascal string, the Desktop Manager relies on the value in ioDTReqCount for determining the length of the buffer.A value of type SInt32.
ioDirIDOn input, the parent directory of the file or directory. A value of type SInt32.

If the specified object already has a comment in the database, the new comment replaces the old.

SPECIAL CONSIDERATIONS

All of the Desktop Manager functions may move or purge memory blocks in the application heap or for some other reason should not be called from within an interrupt. Your application should not call Desktop Manager functions at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.